Skip to content

fix: add sql transaction by log when importing #925

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 19, 2025

Conversation

gfyrag
Copy link
Contributor

@gfyrag gfyrag commented May 19, 2025

No description provided.

@gfyrag gfyrag requested a review from a team as a code owner May 19, 2025 07:36
Copy link

coderabbitai bot commented May 19, 2025

Walkthrough

The Import method in the ledger controller was refactored to execute each log import within its own database transaction. The importLog method now receives a transactional store parameter, ensuring atomicity and improved error handling for each log entry import. Transaction lifecycle management was made explicit in the control flow.

Changes

File(s) Change Summary
internal/controller/ledger/controller_default.go Refactored Import to wrap each log import in a transaction; updated importLog to accept a transactional store parameter and adjusted all internal calls accordingly. Modified error handling for transaction-related errors.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Controller
    participant DB

    Client->>Controller: Import(logs)
    loop For each log
        Controller->>DB: BeginTX()
        Controller->>Controller: importLog(ctx, txStore, log)
        alt Success
            Controller->>DB: Commit()
        else Error (serialization/concurrency)
            Controller->>DB: Rollback()
            Controller->>Client: Return import error
        end
    end
    Controller->>Client: Return result
Loading

Suggested reviewers

  • Dav-14

Poem

In the ledger’s gentle warren,
Each log hops in, one by one—
Wrapped in a cozy transaction,
No race or rollback left undone.
Atomic leaps, errors caught,
Consistent trails, as rabbits ought!
🐇💾

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Commit Unit Tests in branch fix/import-sql-tx-by-log
  • Post Copyable Unit Tests in Comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
internal/controller/ledger/controller_default.go (2)

237-237: Consider removing unnecessary variable.

The err variable on line 237 isn't needed since it's not set after the for loop and would always be nil at this point.

-  return err
+  return nil

217-222: Improve error message formatting.

There's a minor issue with the error message string concatenation where "concurrent transaction occurred" is split across two lines in an unusual way.

-					return NewErrImport(errors.New("concurrent transaction occur" +
-						"red, cannot import the ledger"))
+					return NewErrImport(errors.New("concurrent transaction occurred, cannot import the ledger"))
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 378b51d and 879f214.

⛔ Files ignored due to path filters (8)
  • deployments/pulumi/go.mod is excluded by !**/*.mod
  • deployments/pulumi/go.sum is excluded by !**/*.sum, !**/*.sum
  • go.mod is excluded by !**/*.mod
  • go.sum is excluded by !**/*.sum, !**/*.sum
  • test/rolling-upgrades/go.mod is excluded by !**/*.mod
  • test/rolling-upgrades/go.sum is excluded by !**/*.sum, !**/*.sum
  • tools/generator/go.mod is excluded by !**/*.mod
  • tools/generator/go.sum is excluded by !**/*.sum, !**/*.sum
📒 Files selected for processing (1)
  • internal/controller/ledger/controller_default.go (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Dirty
  • GitHub Check: Tests
🔇 Additional comments (3)
internal/controller/ledger/controller_default.go (3)

207-234: Good transaction management implementation.

The code now wraps each log import within its own database transaction, providing stronger atomicity guarantees. This ensures that each log is either fully imported or not imported at all, preventing partial imports that could lead to data inconsistency.

The implementation includes:

  • Proper transaction lifecycle management (begin, commit, rollback)
  • Comprehensive error handling, especially for concurrent transaction scenarios
  • Clean use of a deferred rollback to prevent leaked transactions

240-240: Good method signature update to support transactions.

Updating the method signature to accept a store parameter allows for the proper use of transactional stores, making the function more flexible and enabling atomic operations.


249-249: Consistent use of the transactional store.

All database operations within the importLog method now consistently use the provided transactional store parameter instead of the controller's store. This ensures that all operations are part of the same transaction and will be committed or rolled back together.

Also applies to: 255-255, 263-263, 270-270, 275-275, 285-285, 290-290, 298-298

Copy link

codecov bot commented May 19, 2025

Codecov Report

Attention: Patch coverage is 32.14286% with 19 lines in your changes missing coverage. Please review.

Project coverage is 82.23%. Comparing base (cf6e6bb) to head (879f214).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
internal/controller/ledger/controller_default.go 32.14% 9 Missing and 10 partials ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #925      +/-   ##
==========================================
+ Coverage   81.96%   82.23%   +0.27%     
==========================================
  Files         141      141              
  Lines        7764     7781      +17     
==========================================
+ Hits         6364     6399      +35     
+ Misses       1074     1057      -17     
+ Partials      326      325       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

switch {
case errors.Is(err, postgres.ErrSerialization) ||
errors.Is(err, ErrConcurrentTransaction{}):
return NewErrImport(errors.New("concurrent transaction occur" +
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a quick one -- shouldn't they all be "NewErrImport" ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm used to define specific errors for business errors.
In the context of the ledger, errors are processed on the api by checking for each kind of error (a bit like a try/catch).
All unknown errors return a 500 and trigger an error log (and trace). Others are translated to a specific business error code.
If we wrap all errors in NewErrImport, technical errors could leak in the api.
I guess we could have two levels of checks api side.

@gfyrag gfyrag added this pull request to the merge queue May 19, 2025
Merged via the queue into main with commit cd0a182 May 19, 2025
9 of 10 checks passed
@gfyrag gfyrag deleted the fix/import-sql-tx-by-log branch May 19, 2025 08:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants